popovermenubar: Add docs
authorMatthias Clasen <mclasen@redhat.com>
Sun, 9 Jun 2019 16:53:59 +0000 (16:53 +0000)
committerMatthias Clasen <mclasen@redhat.com>
Sun, 9 Jun 2019 17:42:11 +0000 (17:42 +0000)
docs/reference/gtk/gtk4-docs.xml
docs/reference/gtk/gtk4-sections.txt
docs/reference/gtk/gtk4.types.in
gtk/gtkpopovermenubar.c

index bd04301299676480d52d56f7a6869e12de65a1b1..e574d082eedf26b5f846dab12b32675629aa84dc 100644 (file)
       <xi:include href="xml/gtkradiotoolbutton.xml" />
       <xi:include href="xml/gtkpopover.xml" />
       <xi:include href="xml/gtkpopovermenu.xml" />
+      <xi:include href="xml/gtkpopovermenubar.xml" />
     </chapter>
 
     <chapter id="SelectorWidgets">
index 4696255497a54bf96288ae1b9f489990ee9088f7..bbb9d6a47595da29346c757615a6119c5f992dd1 100644 (file)
@@ -6491,6 +6491,23 @@ GTK_POPOVER_MENU_GET_CLASS
 gtk_popover_menu_get_type
 </SECTION>
 
+<SECTION>
+<FILE>gtkpopovermenubar</FILE>
+<TITLE>GtkPopoverMenuBar</TITLE>
+GtkPopoverMenuBar
+gtk_popover_menu_bar_new_from_model
+gtk_popover_menu_bar_set_menu_model
+gtk_popover_menu_bar_get_menu_model
+
+<SUBSECTION Standard>
+GTK_TYPE_POPOVER_MENU_BAR
+GTK_IS_POPOVER_MENU_BAR
+GTK_POPOVER_MENU_BAR
+
+<SUBSECTION Private>
+gtk_popover_menu_bar_get_type
+</SECTION>
+
 <SECTION>
 <FILE>gtkmodelbutton</FILE>
 <TITLE>GtkModelButton</TITLE>
index 52f682d10408a7ae53a79d6bcba618f00f1ba3fc..0cfaf1c4e4c9e7ec7770756a4d396070a5bb4239 100644 (file)
@@ -129,6 +129,7 @@ gtk_password_entry_get_type
 gtk_picture_get_type
 gtk_popover_get_type
 gtk_popover_menu_get_type
+gtk_popover_menu_bar_get_type
 @DISABLE_ON_W32@gtk_printer_get_type
 gtk_print_context_get_type
 @DISABLE_ON_W32@gtk_print_job_get_type
index 65bf0e59b7325c0718788070eb2c317606fbec4a..023ae4cd42988d87f0e8359b6a38f4f32a2058b3 100644 (file)
  * License along with this library. If not, see <http://www.gnu.org/licenses/>.
  */
 
+/**
+ * SECTION:gtkpopovermenubar
+ * @Title: GtkPopoverMenuBar
+ * @Short_description: A menu bar with popovers
+ * @See_also: #GtkPopover, #GtkPopoverMenu, #GMenuModel
+ *
+ * The #GtkPopoverBar presents a horizontal bar of items that pop
+ * up popover menus when clicked. The only way to create instances
+ * of GtkPopoverBar is from a #GMenuModel.
+ *
+ * # CSS nodes
+ *
+ * |[<!-- language="plain" -->
+ * menubar
+ * ├── item[.active]
+ * ┊   ╰── popover
+ * ╰── item
+ *     ╰── popover
+ * ]|
+ *
+ * GtkMenuBar has a single CSS node with name menubar, below which
+ * each item has its CSS node, and below that the corresponding
+ * popover.
+ *
+ * The item whose popover is currently open gets the .active
+ * style class.
+ */
+
+
 #include "config.h"
 
 #include "gtkpopovermenubar.h"
@@ -482,6 +511,14 @@ gtk_popover_menu_bar_init (GtkPopoverMenuBar *bar)
 {
 }
 
+/**
+ * gtk_popover_menu_bar_new_from_model:
+ * @model: a #GMenuModel
+ *
+ * Creates a #GtkPopoverMenuBar from a #GMenuModel.
+ *
+ * Returns: a new #GtkPopoverMenuBar
+ */
 GtkWidget *
 gtk_popover_menu_bar_new_from_model (GMenuModel *model)
 {
@@ -490,6 +527,14 @@ gtk_popover_menu_bar_new_from_model (GMenuModel *model)
                        NULL);
 }
 
+/**
+ * gtk_popover_menu_bar_set_menu_model:
+ * @bar: a #GtkPopoverMenuBar
+ * @model: a #GMenuModel
+ *
+ * Sets a menu model from which @bar should take
+ * its contents.
+ */
 void
 gtk_popover_menu_bar_set_menu_model (GtkPopoverMenuBar *bar,
                                      GMenuModel        *model)
@@ -522,6 +567,14 @@ gtk_popover_menu_bar_set_menu_model (GtkPopoverMenuBar *bar,
     }
 }
 
+/**
+ * gtk_popover_menu_bar_get_menu_model:
+ * @bar: a #GtkPopoverMenuBar
+ *
+ * Returns the model from which the contents of @bar are taken.
+ *
+ * Returns: (transfer none): a #GMenuModel
+ */
 GMenuModel *
 gtk_popover_menu_bar_get_menu_model (GtkPopoverMenuBar *bar)
 {